Skip to content

Use dash in input parameter naming in workflow syntax example - #45260

Closed
kohtala wants to merge 1 commit into
github:mainfrom
kohtala:patch-1
Closed

Use dash in input parameter naming in workflow syntax example#45260
kohtala wants to merge 1 commit into
github:mainfrom
kohtala:patch-1

Conversation

@kohtala

@kohtala kohtala commented Jul 23, 2026

Copy link
Copy Markdown

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Existing actions customarily use dash rather than underscore in action names their inputs. The example should do the same to support consistent style.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Copilot AI review requested due to automatic review settings July 23, 2026 15:55
@welcome

welcome Bot commented Jul 23, 2026

Copy link
Copy Markdown

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jul 23, 2026
@github-actions

github-actions Bot commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/reference/workflows-and-actions/workflow-syntax.md fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

Copilot AI reviewed Jul 23, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates a workflow syntax example to use hyphens consistently in action and input names.

Changes:

  • Replaces underscores with hyphens in example identifiers.
  • Retains corresponding input environment-variable documentation.

Comment thread content/actions/reference/workflows-and-actions/workflow-syntax.md Outdated
@kohtala
Use dash in input parameter naming in workflow syntax example
7880d44 
Existing actions customarily use dash rather than underscore in action
names and their inputs. The example should do the same to support
consistent style.
@abimaelmar27-design

This comment was marked as spam.

Sign in to view
CodeWave21

This comment was marked as spam.

Sign in to view

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code and removed triage Do not begin working on this issue until triaged by the team labels Aug 7, 2026
@Sharra-writes

Sharra-writes commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

@kohtala Thanks, but we're okay leaving our examples as they are!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
+2 more reviewers
@TeriASwims TeriASwims TeriASwims left review comments
@CodeWave21 CodeWave21 CodeWave21 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@kohtala @abimaelmar27-design @Sharra-writes @TeriASwims @CodeWave21